/*
 * Copyright 2007-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 * 
 * Project: JGentleFramework
 */
package org.jgentleframework.reflection;

import java.lang.reflect.Field;

/**
 * This interface represents the <code>field identification</code>, designates a
 * field or a set of fields corresponding to declaring class and one
 * <code>regular expression</code> of name. The <code>identification data</code>
 * shall be used conjointly with reflection tools in order to access specified
 * fields.
 * 
 * @author LE QUOC CHUNG - mailto: <a
 *         href="mailto:skydunkpro@yahoo.com">skydunkpro@yahoo.com</a>
 * @date Jul 21, 2008
 * @see MemberIdentification
 * @see Identification
 */
public interface FieldIdentification extends MemberIdentification<Field> {
	/**
	 * Gets the name.
	 * 
	 * @return the name
	 */
	public String getName();

	/**
	 * Gets the declaring class.
	 * 
	 * @return the declaringClass
	 */
	public Class<?> getDeclaringClass();

	/**
	 * Checks if is found on superclass.
	 * 
	 * @return the foundOnSuperclass
	 */
	public boolean isFoundOnSuperclass();

	/**
	 * Gets the modifiers.
	 * 
	 * @return the modifiers
	 */
	public int getModifiers();
}